DISPLAY BROWSE statement

Purpose

Display a folder selection dialog to return the user's choice.

Syntax

DISPLAY BROWSE [hParent], [xpos&], [ypos&], title$, start$, flags& TO folder$

hParent

Handle of the parent window or dialog. If there is no parent, use zero (0) or %HWND_DESKTOP.

xpos&

Horizontal position, in pixels, relative to the parent window. If omitted, PowerBASIC selects the position (offset from the parent, or centered if no parent).

ypos&

Vertical position, in pixels, relative to the parent window. If missing, PowerBASIC selects the position (offset from the parent, or centered if no parent).

title$

The caption to be displayed below the caption bar of the dialog box. If this parameter is a null string, the title "Open" is displayed.

start$

A string which specifies the starting path to be used as the initial default folder. This may be disabled by passing a nul, zero-length string ("").

flags&

The style attributes of the BROWSE Dialog. The following values may be used alone or combined, and are predefined in the PowerBASIC compiler:

%BIF_BROWSEINCLUDEFILES (4.71)	The dialog box will display both files and folders.
%BIF_BROWSEINCLUDEURLS	The dialog box can display URL's if %BIF_USENEWUI and %BIF_BROWSEINCLUDEFILES are also set.
%BIF_DONTGOBELOWDOMAIN	Does not include network folders below the domain level in the treeview control.
%BIF_EDITBOX	Includes an edit control in the dialog box that allows the user to type the name of an item.
%BIF_NEWDIALOGSTYLE (5.0)	Provides the new user interface, a larger dialog box that can be resized. It also offers drag-and-drop capability within the dialog box, reordering, shortcut menus, new folders, delete, and other shortcut menu commands. This is the default style implemented by PowerBASIC.
%BIF_NONEWFOLDERBUTTON (6.0)	Do not include the "New Folder" button in the dialog box.
%BIF_NOTRANSLATETARGETS (6.0)	When the selected item is a shortcut, return the PIDL of the shortcut itself rather than its target.
%BIF_RETURNFSANCESTORS	Only returns file system ancestors. With any other selection, the OK button is grayed.
%BIF_RETURNONLYFSDIRS	Only returns file system directories. With any other selection, the OK button is grayed.
%BIF_SHAREABLE (5.0)	The dialog box can display shareable resources on remote systems. It is intended for applications that want to expose remote shares on a local system. The %BIF_NEWDIALOGSTYLE flag must also be set.
%BIF_UAHINT (6.0)	When this flag is combined with %BIF_NEWDIALOGSTYLE, adds a usage hint to the dialog box in place of the edit box.
%BIF_USENEWUI (5.0)	Use the new user interface, plus an edit box.

folder$

Contains the drive letter and path to the folder the user selected. If an error occurs or the user clicks the cancel button, this variable is set to a nul, zero-length string.